feat(cli): read evlog.config.ts in map, logs, config and doctor - #806

🔗 Linked issue

Layer 2 of the stack that replaces #803.

Stack (GitHub stack #818, merge from the bottom up)

• fix: skip the silent drain warning when nuxt and nitro bake the config #804 fix: skip the silent drain warning when nuxt and nitro bake the config, merged
• feat(core): add extends and mergeEvlogConfig to defineEvlog #805 feat(core): add extends and mergeEvlogConfig to defineEvlog, merged
• feat(cli): read evlog.config.ts in map, logs, config and doctor #806 feat(cli): read evlog.config.ts in map, logs, config and doctor, against main (this PR)
• feat: load evlog.config.ts in the nuxt and nitro modules and eve hooks #807 feat: load evlog.config.ts in the nuxt and nitro modules and eve hooks, against feat(cli): read evlog.config.ts in map, logs, config and doctor #806
• feat(cli): write evlog.config.ts from evlog init #808 feat(cli): write evlog.config.ts from evlog init, against feat: load evlog.config.ts in the nuxt and nitro modules and eve hooks #807
• docs: show the evlog.config.ts wiring on every framework page #809 docs: show the evlog.config.ts wiring on every framework page, against feat(cli): write evlog.config.ts from evlog init #808

📚 Description

evlog map and evlog logs read evlog.config.ts (or .mts, .js, .mjs), the nearest one from the package up to the workspace root. The CLI parses the file with oxc and never runs it.

import { defineEvlog } from 'evlog'
import base from '../../evlog.config'

export default defineEvlog({
  extends: base,
  env: { service: 'shop' },
  map: { ignore: ['src/internal/**'], rules: { 'error-handling': 'off' } },
  logs: { limit: 50 },
})

A flag wins over the config. The config can extend a local file or a published preset, one level deep. extends takes the imported config, the same value the app merges at runtime, so a string path stops with CONFIG_EXTENDS_STRING.

evlog config prints the settings that apply and the file and line each one comes from, and --json prints the same as JSON. Output from this branch, for an app with two routed services that extends a base config:

evlog.config.ts · extends ./base/evlog.config → base/evlog.config.ts

Services · first matching route wins
  /api/auth/**          auth           evlog.config.ts:9
  /api/billing/v1.2/**  billing        evlog.config.ts:10
  any other route       shop           evlog.config.ts:7
  environment           from NODE_ENV  default

Sampling
  trace  0%      default
  debug  0%      base/evlog.config.ts:4
  info   10%     evlog.config.ts:14
  warn   100%    default
  error  100%    default
  fatal  always  default

Redaction
  redact    on                                                 evlog.config.ts:13
  builtins  creditCard, email, ipv4, phone, jwt, bearer, iban  default
  paths     user.email                                         base/evlog.config.ts:3
            card.number                                        evlog.config.ts:13

Pipeline
  drain  createAxiomDrain()  evlog.config.ts:12

CLI · read by evlog map and evlog logs
  map.rules.audit  'off'          base/evlog.config.ts:5
  logs.dir         '.evlog/logs'  evlog.config.ts:15

The output is grouped by what each setting does. Services follow route order, sampling lists every level with its default, a computed value shows its expression instead of its code, and --json keeps the flat cli and app lists.

evlog doctor reports a config it can't read. A misspelt setting, a value under map or logs computed at runtime, or turning off wide-event or context stops the command with a cli.CONFIG_* error (CONFIG_INVALID, CONFIG_NOT_STATIC, CONFIG_EXTENDS_DEPTH, CONFIG_EXTENDS_NOT_FOUND, CONFIG_EXTENDS_STRING, CONFIG_NO_EXPORT, CONFIG_PARSE_FAILED).

Decisions to review

• The @evlog/cli peer range for evlog moves to >=2.31.0, since the CLI imports mergeEvlogConfig from layer 1.
• Config paths (logs.dir, map.baseline) resolve from the analysed package, not from the config file.
• wide-event and context can't be turned off in map.rules. map.ignore is the way to skip an entry point.
• A preset's exports map is resolved in the package's own key order with the ESM conditions, and a package.json that doesn't parse counts as not found.

Not covered: map.ignore matches route files, not routes declared inline in one file.

Checks run: packages/cli 641 tests pass, tsc and the build are clean, content-lint scores 100 on the changed docs pages and changeset.

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

Summary by CodeRabbit

• New Features

  • Added project-level evlog.config settings for map checks and log browsing, including rule overrides, entry-point exclusions, score thresholds, baselines, log directories, and result limits. Command-line flags take precedence.
  • Map reports show excluded entry points and identify the source of score thresholds.
  • Added evlog config to display applicable settings, their sources, and configuration search details in text or JSON.
  • evlog doctor reports configuration status and issues when a project config is present.

• Documentation

  • Expanded CLI guidance on configuration discovery, settings, presets, validation, and errors.